home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 1.iso / ARGONET / PD / EDITORS / CHANGE_TEXT_22.SPK / !ChangeTxt / !Help < prev    next >
Text File  |  1997-05-19  |  10KB  |  261 lines
  1.                              ChangeTxt v2.2 27/4/97
  2.                              ======================
  3.  
  4.  
  5. Overview
  6. ========
  7.  
  8. ChangeTxt converts text files between Acorn, PC and Macintosh platforms.
  9. A registered version of ChangeTxt supports the following features:
  10.  
  11.    - Line terminator mapping. i.e <CR> to <LF>, etc.
  12.  
  13.    - Character set mapping between Acorn, DOS, OS/2 & Macintosh 
  14.      platforms. So a bullet '•' will still look like a '•' even
  15.      if it has a different ASCII value between character sets.
  16.  
  17.    - Strips invisible characters. Expands tabs.
  18.  
  19.    - Provides direct conversions between platforms:
  20.      Acorn to Mac, Dos, OS/2
  21.      Dos to Acorn, Mac , OS/2
  22.      Mac to Acorn, DOS, OS/2
  23.      OS/2 to Mac, Acorn, DOS
  24.  
  25.    - Guess platform type. ChangeTxt will examine the contents of a text
  26.      file and automatically choose a source platform to map to your
  27.      destination platform.
  28.  
  29.    - Fully multitasking. All file conversions are performed in
  30.      background. Allows multiple files to be converted, even add files
  31.      with a different mapping during conversion.
  32.  
  33.    - Support for multiple preference files for regularly performed
  34.      conversions.
  35.  
  36. An unregistered version only supports mapping between DOS and Acorn,
  37. character set and line terminator mapping and multitasking. 
  38.  
  39. For details on registration see the end of this file.
  40.  
  41. Using ChangeTxt
  42. ===============
  43.  
  44. To launch ChangeTxt, just double-click on the !ChangeTxt icon which will 
  45. then appear on the right hand side of the icon bar.
  46.  
  47. To view the ChangeTxt dialog click on the !ChangeTxt icon on the icon bar.
  48.  
  49. The ChangeTxt dialog is described below from the top of dialog down.
  50.  
  51. Preferences
  52. ===========
  53.  
  54. The preferences panel enables a variety of conversions to be named and saved for later
  55. recall and use. The preferences saved consist of the conversion options and the source and
  56. destination file types.
  57.  
  58. The writable icon is used to select the preferences file to be loaded, saved or
  59. deleted. This can be typed into or the menu beside it can be used when selecting existing
  60. preference files. Selecting a menu item or hitting Return in the writable icon
  61. automatically loads the required preference file and updates the dialog.
  62.  
  63. The menu lists the currently known preference file set. These files are stored in the Prefs
  64. directory of the application.
  65.  
  66. The 'Add' button saves the current dialog settings into the currently selected preference
  67. file name as given in the writable icon. An existing preference file is overwritten.
  68.  
  69. The 'Remove' button deletes the currently selected preference file from the disk as given
  70. in the writable icon.
  71.  
  72. The preference file used to set the dialog state is shown in the dialog title. When dialog
  73. options are changed the title is modified with an asterisk '*'. Loading another preference
  74. file into a modified dialog or quitting the application will cause a save dialog to appear.
  75. Selecting the 'Save' option will save the current dialog state into the preference name given
  76. in the window title. Selecting 'Discard' will cause the current dialog state to be ignored
  77. and the load or quit action performed. Selecting 'Cancel' causes the action to be aborted.
  78.  
  79. Conversions
  80. ============
  81.  
  82.    Character set - if ticked, the source characters are mapped onto the
  83.                    destination character set. e.g. • will map to •
  84.                    Otherwise without character set mapping a • may map to ¢
  85.                    Any character that cannot be mapped will be translated to
  86.                    a ?
  87.  
  88.    Termination - if ticked then the source format line terminators are converted to
  89.                  the appropriate target format line terminators, otherwise no
  90.                  conversion of the line terminators is performed;
  91.  
  92.    Strip codes - if ticked then all control code characters are stripped from
  93.                  the destination file. Control code characters are the
  94.                  non-printable characters in the range of 0-31 ASCII, but
  95.                  not including the destination format line terminators nor the
  96.                  tab character;
  97.  
  98.    Expand tabs - if ticked then any tab characters to be written to the destination
  99.                  file are converted to a number of spaces as specified in the
  100.                  spaces writable icon.
  101.  
  102.  
  103. Below the conversion options are two pop-up menus separated by an arrow.
  104. The pop-up menu to the left of the arrow is the source format. The pop-up
  105. menu to the right of the arrow is the destination format.
  106.  
  107. The source and destination menus allow the user to specify one of the following
  108. formats as either source or destination: Mac, DOS, Acorn, OS/2
  109.  
  110. The source menu has an additional item, Guess. When Guess is selected, ChangeTxt
  111. will examine the contents of the source file in an attempt to identify the source
  112. format. It will then convert the file to the selected destination format. As OS/2 
  113. and DOS text files are similar, any conflict on guessing will default to DOS.
  114.  
  115. If the source and destination file types are the same then ChangeTxt ignores the 
  116. 'Character set' and 'Termination' conversion options. This information remains unchanged
  117. when the source characters are transferred to the destination. The other conversion options
  118. are acted upon as usual.
  119.  
  120. Hints
  121. =====
  122.  
  123. ChangeTxt can convert source file formats into destination file formats using a very
  124. simple list of mapping options. The ability to turn the various options on and off allows 
  125. the user to convert files which are not 'true' platform files, e.g. a PC text file saved 
  126. in an Acorn file format. A far from exhaustive list of examples using the various options 
  127. is given below.
  128.  
  129. To strip all non-linefeed control codes from an Acorn file:
  130.  
  131.         Select Acorn to Acorn as the mapping
  132.         Tick the 'Strip codes' conversion option
  133.         Drag the file to be converted onto ChangeTxt
  134.  
  135. To convert a source file which contains the Macintosh character set but has PC line
  136. terminators into a destination Acorn file:
  137.  
  138.         Select PC to Mac as the mapping
  139.         Untick the 'Character set' conversion option, otherwise the Macintosh
  140.           characters would be mapped onto their PC equivalents
  141.         Drag the file to be converted onto ChangeTxt
  142.         Save the result file
  143.         Select Mac to Acorn as the mapping
  144.         Tick the 'Character set' conversion option
  145.         Drag the result file from the previous conversion onto ChangeTxt
  146.  
  147. Status
  148. ======
  149.  
  150. During conversion, the window displays the name of the file currently being 
  151. converted.
  152.  
  153. Below this a red bar shows the progress of the file being converted.
  154.  
  155. Below this a green bar shows the progress through a batch of files.
  156.  
  157. Drop files here
  158. ===============
  159.  
  160. To perform a conversion, drag the file to be converted onto the window.
  161. A save dialog is presented which is used to give the destination path for 
  162. the converted file. If multiple files are dragged onto the window then a 
  163. destination directory is acquired. The converted file names are then the same 
  164. as the original file names, but placed in the given directory.
  165.  
  166. The conversion of the text files occurs in background. More files can be 
  167. selected for conversion while current conversions are taking place. ChangeTxt
  168. remembers the conversion mapping associated with each file, so different jobs
  169. can have different mappings.
  170.  
  171. Conversion can be aborted by clicking on the abort button in the window.
  172. Aborting terminates all currently identified conversions. Abortion is 
  173. automatic if the window is closed or the program is quitted.
  174.  
  175.  
  176. ArcWeb Support
  177. ==============
  178.  
  179. ChangeTxt can now be used alongside the ArcWeb browser to automatically convert foreign
  180. text file formats to Acorn format before viewing. Conversion of the foreign file formats
  181. is performed using the standard ChangeTxt dialog options. ChangeTxt can also be instructed
  182. to terminate when ArcWeb terminates, so it can be placed in the WebHelper folder along with
  183. the other helpers.
  184.  
  185.  
  186. Icon Bar Menu
  187. =============
  188.  
  189.         Info             -> displays the standard information dialog plus
  190.                             registration details
  191.         Report           -> displays the file conversion report window
  192.         Quit with ArcWeb -> if ticked then ChangeTxt will quit when ArcWeb quits. This option
  193.                             state is remembered automatically by the application on quitting
  194.         Quit             -> quits the ChangeTxt application
  195.  
  196.  
  197. Dialog Menu
  198. ===========
  199.  
  200. The dialog menu contains a subset of the Icon Bar Menu options.
  201.  
  202. Limitations
  203. ===========
  204.  
  205. ChangeTxt has not been tested under RISC OS 2.
  206.  
  207. Registration
  208. ============
  209.  
  210. ChangeTxt uses a registration system which uses a key to enable full 
  211. functionality of the application. Without the key then ChangeTxt will 
  212. only allow a subset of its features to be used.
  213.  
  214. If you wish to register and use all of ChangeTxt's features then send
  215. your name and address, along with a cheque for £10 (£30 for commercial users)
  216. sterling to the address below.
  217.  
  218. In return we will send you a key which will enable all ChangeTxt's features.
  219. The key belongs to you and will ensure that you will be able to fully use 
  220. any future versions of ChangeTxt.
  221.  
  222. As a registered user you may have any number of copies as your name
  223. will appear in the program information dialog. You can also send us
  224. a disc with your key for the latest version, which we will return to you.
  225.  
  226. Point of Contact
  227. ================
  228.  
  229. If you have any technical queries/suggestions then please write to Darryl Sims, at:
  230.  
  231. dsims@ehorizon.demon.co.uk
  232.  
  233. For registration please send a cheque or postal order made payable to Paul Gee
  234. at the address below. Please remember to include your return address or e-mail
  235. address so we can return your registration key.
  236.  
  237. The Event Horizon
  238. Bank Cottage
  239. 24 High Street
  240. Cowden
  241. Kent
  242. TN8 7JG
  243.  
  244. e-mail: pgee@ehorizon.demon.co.uk
  245.  
  246. © The Event Horizon, All Rights Reserved 1996,1997.
  247.  
  248. History
  249. =======
  250.  
  251. v2.1 - Fixed erroneous behaviour whenever a file is dragged to the icon bar before the
  252.        conversion dialog has been opened.
  253.        Fixed failure of the registered mappings to respond to all of the dialog options.
  254.        Added preferences option.
  255.        Added ArcWeb browser support so ChangeTxt can act as a helper.
  256.  
  257. v2.2 - Added support for identical source and destination.
  258.        Added support for multiple conversion preference files. Separated conversion
  259.        preferences from application preferences.
  260.        Minor alterations made to dialog layout.
  261.